/***************************************************************************
 * Copyright 2012-2013 TXT e-solutions SpA
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * This work was performed within the IoT_at_Work Project
 * and partially funded by the European Commission's
 * 7th Framework Programme under the contract ICT-257367.
 *
 * Authors:
 *      Salvatore Piccione (TXT e-solutions SpA)
 *
 * Contributors:
 *        Domenico Rotondi (TXT e-solutions SpA)
 **************************************************************************/
package it.txt.ens.client.subscriber.factory;

import it.txt.ens.client.core.ENSEvent;
import java.util.Date;
import java.util.Map;

/**
 * This interface defines methods to create {@link ENSEvent} objects to be consumed.
 * 
 * @author Salvatore Piccione (TXT e-solutions SpA - salvatore.piccione AT txtgroup.com)
 * @author Domenico Rotondi (TXT e-solutions SpA - domenico.rotondi AT txtgroup.com)
 *
 */
public interface ENSEventFactory {
    
//    public ENSEvent create (String pattern, Map<String, Object> headers, byte[] payload, 
//            Date timestamp, boolean isPersistent, String applicationID);
    /**
     * Creates a consumable event.
     * @param pattern the pattern that identifies the namespace node under which the event has been published.<br/>
     * @param headers the event headers
     * @param payload the informative content of the event
     * @param contentType the media type of the payload
     * @param contentEncoding the encoding of the payload
     * @param priority the event priority
     * @param timestamp the time when the event has been issued
     * @param isPersistent <code>true</code> if the event is <i>persistent</i>, <code>false</code> otherwise
     * @param applicationID the unique identifier of the event publisher.
     * @return an event
     */
    public ENSEvent create (String pattern, Map<String, Object> headers, byte[] payload,
            String contentType, String contentEncoding, int priority, 
            Date timestamp, boolean isPersistent, String applicationID);
}
